home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 2 / AACD 2.iso / AACD / Programming / MUI / MCC_VLab / Developer / autodocs / VLabImage.autodoc < prev   
Encoding:
Text File  |  1999-05-18  |  6.4 KB  |  238 lines
  1. TABLE OF CONTENTS
  2.  
  3. VLabImage/--background--
  4. VLabImage/MUIA_VLabImage_Height
  5. VLabImage/MUIA_VLabImage_VMemName
  6. VLabImage/MUIA_VLabImage_Width
  7. VLabImage/MUIM_VLabImage_ObtainRGBPointer
  8. VLabImage/MUIM_VLabImage_ObtainYUVPointer
  9. VLabImage/MUIM_VLabImage_ReleaseRGBPointer
  10. VLabImage/MUIM_VLabImage_ReleaseYUVPointer
  11. VLabImage/--background--                             VLabImage/--background--
  12.  
  13.    PURPOSE
  14.  A storage class for storing grabbed VLab images.
  15.  
  16.  This class is a private sub-class of VLab.mcc, however some of the 
  17.  methods used by this class are available to the user.
  18.  An object of this class can simply be attached to a window. Opening
  19.  the window will show the image. You don't have to do this, if you
  20.  want to do your own custom displaying or you want to save it, simply 
  21.  use the MUIM_VLabIMage_ObtainRGBPointer method to get a buffer pointer
  22.  to a RGB triplet (Chunky - RRGGBB) buffer.
  23.  *NOTE* If you want to change the buffer, ie rotate it, scale it etc..
  24.  you **MUST** copy the buffer first.
  25.  DO NOT MODIFY THE SOURCE RGB BUFFER PASSED TO YOU, COPY IT FIRST.
  26.  
  27.  Features:
  28.  De-Interlacing images
  29.  Will render to any native Amiga screen, or a CyberGraphX
  30.  screen. Rendering to native screens can be slow. If CyberGraphics
  31.  is installed, it is automatically used.
  32.  
  33.    THANKYOUS
  34.  Many thanks to
  35.    Paul Huxham
  36.      - For his expertise and incredible knowledge of the Amiga platform.
  37.  
  38.    Frank Mariak
  39.      - For his modified vlab.library and help with the monitor.
  40.  
  41.    Stefan Stuntz
  42.      - For MUI!
  43.  
  44.    Debra Quartly
  45.      - For her love and patience.
  46.  
  47.    AUTHOR
  48.   You can contact the author via:
  49.     email: steveq@mafeking.scouts.org.au
  50.   or
  51.    1280 Stevens St
  52.    Mundaring,
  53.     Western Australia 6073
  54.  
  55. VLabImage/MUIA_VLabImage_Height               VLabImage/MUIA_VLabImage_Height
  56.  
  57.    NAME
  58.  MUIA_VLabImage_Height --  [..G], LONG
  59.  
  60.    FUNCTION
  61.  You can use this to read the height of the grabbed image.
  62.  
  63.    BUGS
  64.  None known.
  65.  
  66.    SEE ALSO
  67.  MUIA_VLabImage_Width
  68. VLabImage/MUIA_VLabImage_VMemName           VLabImage/MUIA_VLabImage_VMemName
  69.  
  70.    NAME
  71.  MUIA_VLabImage_VMemName --  [..G], STRPTR
  72.  
  73.    FUNCTION
  74.  You can use this to return a string pointer to the virtual memory
  75.  file name that was allocated for this grabbed image.
  76.  
  77.    NOTE
  78.  Of course this is only available if VMem is turned on, and you
  79.  should allow for a NULL if it's not. 
  80.  This name is only valid for the life of the object, unless
  81.  "Delete Virtual Memory file when disposed" in the settings is not
  82.  checked, in which case the file will be available even after
  83.  the object is disposed.
  84.  The format of the VMem files is a YUV iff file.
  85.  
  86.    BUGS
  87.  None known.
  88.  
  89.    SEE ALSO
  90.  
  91. VLabImage/MUIA_VLabImage_Width                 VLabImage/MUIA_VLabImage_Width
  92.  
  93.    NAME
  94.  MUIA_VLabImage_Width --  [..G], LONG
  95.  
  96.    FUNCTION
  97.  You can use this to read the width of the grabbed image.
  98.  
  99.    BUGS
  100.  None known.
  101.  
  102.    SEE ALSO
  103.  MUIA_VLabImage_Height
  104. VLabImage/MUIM_VLabImage_ObtainRGBPointermage/MUIM_VLabImage_ObtainRGBPointer
  105.  
  106.    NAME
  107.  MUIM_VLabImage_ObtainRGBPointer -- Get a pointer to a RGB image.
  108.  
  109.    SYNOPSIS
  110.  result = DoMethod( obj, MUIM_VLabImage_ObtainRGBPointer, &rgb );
  111.  
  112.  ULONG DoMethod( Object *obj, MUIM_VLabImage_ObtainRGBPointer,
  113.                  ULONG **rgb );
  114.  
  115.    FUNCTION
  116.  This method will return a pointer (rgb triplets) to the grabbed image.
  117.  This function has to do a YUV to RGB conversion, so it is not fast.
  118.  
  119.    INPUTS
  120.  rgb - Pointer to a where to store the rgb pointer.
  121.  
  122.    RESULT
  123.  VLABERR_OK - if successful
  124.   An error code if unsuccessful.
  125.  See vlab_mcc.h for possible error codes.
  126.  
  127.    WARNING
  128.  A call to MUIM_VLabImage_ReleaseRGBPointer must be made when you have
  129.  finished with the buffer. 
  130.  Failure to release this pointer when you have finished with them
  131.  will cause Virtual Memory problems.
  132.  
  133.    BUGS
  134.  None known.
  135.  
  136.    SEE ALSO
  137.  MUIM_VLabImage_ObtainYUVPointer, MUIM_VLabImage_ReleaseYUVPointer,
  138.  MUIM_VLabImage_ReleaseRGBPointer
  139. VLabImage/MUIM_VLabImage_ObtainYUVPointermage/MUIM_VLabImage_ObtainYUVPointer
  140.  
  141.    NAME
  142.  MUIM_VLabImage_ObtainYUVPointer -- Get pointers to a YUV image.
  143.  
  144.    SYNOPSIS
  145.  result = DoMethod( obj, MUIM_VLabImage_ObtainYUVPointer, &y, &u, &v )
  146.  
  147.  ULONG DoMethod( Object *obj, MUIM_VLabImage_ObtainYUVPointer,
  148.                  ULONG **y, ULONG **u, ULONG **v )
  149.  
  150.    FUNCTION
  151.  When the VLab card grabs an image, it is grabbed in a YUV format.
  152.  This method will return pointers (y,u,v) to the grabbed image.
  153.  
  154.    INPUTS
  155.  y - Pointer to a where to store the y pointer.
  156.  u - Pointer to a where to store the u pointer.
  157.  v - Pointer to a where to store the v pointer.
  158.  
  159.    RESULT
  160.  VLABERR_OK - if successful
  161.   An error code if unsuccessful.
  162.  See vlab_mcc.h for possible error codes.
  163.  
  164.    WARNING
  165.  A call to MUIM_VLabImage_ReleaseYUVPointer must be made when you have
  166.  finished with the buffer.
  167.  Failure to release these pointers when you have finished with them
  168.  will cause Virtual Memory problems.
  169.  
  170.    BUGS
  171.  None known.
  172.  
  173.    SEE ALSO
  174.  MUIM_VLabImage_ReleaseYUVPointer, MUIM_VLabImage_ObtainRGBPointer,
  175.  MUIM_VLabImage_ReleaseRGBPointer
  176. VLabImage/MUIM_VLabImage_ReleaseRGBPointerge/MUIM_VLabImage_ReleaseRGBPointer
  177.  
  178.    NAME
  179.  MUIM_VLabImage_ReleaseRGBPointer --
  180.                                   Release a previously obtained RGB pointer.
  181.  
  182.    SYNOPSIS
  183.  result = DoMethod( obj, MUIM_VLabImage_ReleaseRGBPointer, rgb )
  184.  
  185.  ULONG DoMethod( Object *obj, MUIM_VLabImage_ReleaseRGBPointer,
  186.                  ULONG *rgb )
  187.  
  188.    FUNCTION
  189.  This method will release a previously obtainded rgb pointer.
  190.  Failure to release these pointers when you have finished with them
  191.  will cause Virtual Memory problems.
  192.  
  193.    INPUTS
  194.  rgb - Pointer to the rgb buffer.
  195.  
  196.    RESULT
  197.  
  198.    WARNING
  199.  
  200.    BUGS
  201.  None known.
  202.  
  203.    SEE ALSO
  204.  MUIM_VLabImage_ObtainYUVPointer, MUIM_VLabImage_ReleaseYUVPointer,
  205.  MUIM_VLabImage_ObtainRGBPointer
  206. VLabImage/MUIM_VLabImage_ReleaseYUVPointerge/MUIM_VLabImage_ReleaseYUVPointer
  207.  
  208.    NAME
  209.  MUIM_VLabImage_ReleaseYUVPointer -- Release previously obtained YUV pointers
  210. .
  211.  
  212.    SYNOPSIS
  213.  result = DoMethod( obj, MUIM_VLabImage_ReleaseYUVPointer, y, u, v )
  214.  
  215.  ULONG DoMethod( Object *obj, MUIM_VLabImage_ReleaseYUVPointer,
  216.                  ULONG *y, ULONG *u, ULONG *v )
  217.  
  218.    FUNCTION
  219.  This method will release previously obtainded y,u,v pointers.
  220.  Failure to relase these pointers when you have finished with them
  221.  will cause Virtual Memory problems.
  222.  
  223.    INPUTS
  224.  y - Pointer to the y buffer.
  225.  u - Pointer to the u buffer.
  226.  v - Pointer to the v buffer.
  227.  
  228.    RESULT
  229.  
  230.    WARNING
  231.  
  232.    BUGS
  233.  None known.
  234.  
  235.    SEE ALSO
  236.  MUIM_VLabImage_ObtainYUVPointer, MUIM_VLabImage_ObtainRGBPointer,
  237.  MUIM_VLabImage_ReleaseRGBPointer
  238.